/*

 * Licensed to the Apache Software Foundation (ASF) under one

 * or more contributor license agreements.  See the NOTICE file

 * distributed with this work for additional information

 * regarding copyright ownership.  The ASF licenses this file

 * to you under the Apache License, Version 2.0 (the

 * "License"); you may not use this file except in compliance

 * with the License.  You may obtain a copy of the License at

 *

 *     http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

package com.bff.gaia.unified.sdk.metrics;



import com.google.auto.value.AutoValue;

import com.bff.gaia.unified.sdk.annotations.Experimental;

import com.bff.gaia.unified.sdk.annotations.Experimental.Kind;



import javax.annotation.Nullable;

import java.io.Serializable;



/** Metrics are keyed by the step name they are associated with and the name of the metric. */

@Experimental(Kind.METRICS)

@AutoValue

public abstract class MetricKey implements Serializable {



  /** The step name that is associated with this metric or Null if none is associated. */

  @Nullable

  public abstract String stepName();



  /** The name of the metric. */

  public abstract MetricName metricName();



  @Override

  public String toString() {

    return String.format("%s:%s", stepName(), metricName());

  }



  public static MetricKey create(@Nullable String stepName, MetricName metricName) {

    return new AutoValue_MetricKey(stepName, metricName);

  }

}